Update Record
Description
ManagedEngine SDP: Update Record step updates a record in a module in ManageEngine ServiceDesk Plus.
Compatibility: Update Plugin step is compatible with on-premise as well as cloud instances of ManageEngine SDP and works on Linux and Windows environments.
References:
- Cloud API documentation and common error codes: https://www.manageengine.com/products/service-desk/sdpod-v3-api/SDPOD-V3-API.html
- On-premise API documentation: Login to ServiceDesk on-premise application using your admin user name and password -> click Admin -> API -> Documentation
Configurations
| No. | Field Name | Description |
|---|---|---|
| General Tab: | ||
| Step Name | Name of the step. This name has to be unique in a single workflow. | |
| Connection: | ||
| 1 | Deployment Type | Specify the Deployment type of the ManageEngine SDP instance. Select one from the dropdown i.e. either CLOUD or ON_PREMISE. Note: - Auth Token is displayed when Deployment Type is ON_PREMISE. - Client ID, Client Secret and Refresh Token arev displayed when Deployment Type is CLOUD. |
| 2 | Base URL | Base URL of ManageEngine ServiceDesk Plus (e.g. https://sdpondemand.manageengine.com for on cloud instance) The data type is string. This field is mandatory. |
| Auth Token: | ||
| 3 | Accept Values as variable/ static | Leave checkbox unchecked to accept Auth Token value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Auth Token field to appear as Text box. |
| 4 | Auth Token | Specify the API Key generated in ManageEngine ServiceDesk Plus instance. This field is visible when selecting the Deployment Type as “ON_PREMISE”. If checkbox above is enabled Auth Token field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Auth Token field appears as a drop down containing values from previous steps. The data type is secure string. This field is mandatory. |
| 5 | Accounts Server URL | Accounts Server URL specific Data Centre of ManageEngine SDP instance (https://www.manageengine.in/products/service-desk/sdpod-v3-api/getting-started/data-centers.html). This field is visible when selecting the Deployment Type as “CLOUD”. |
| 6 | Client ID | Specify the Client ID of the client created in the ManageEngine SDP developer console. This field is visible when selecting the Deployment Type as “CLOUD”. The data type is string. |
| Client Secret: | ||
| 7 | Checkbox: Accept Value as variable/static | Leave checkbox unchecked to accept Client Secret value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Client Secret field to appear as Text box. |
| 8 | Client Secret | Specify the Client Secret of the client created in the ManageEngine SDP developer console. This field is visible when selecting the Deployment Type as “CLOUD”. The data type is secure string. |
| Refresh Token: | ||
| 9 | Checkbox: Accept Value as variable/static | Leave checkbox unchecked to accept Refresh Token value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Refresh Token field to appear as Text box. |
| 10 | Refresh Token | Specify the Refresh Token generated from the access token. This field is visible when selecting the Deployment Type as “CLOUD”. The data type is secure string. |
**Known Issue: **
- Even though the provided connection details may be valid, the “access_denied” error occurs intermittently for the cloud deployment.
- HTTP-401 unauthorized error occurs intermittently due to a limitation from ManageEngine SDP cloud.
| No. | Field Name | Description |
|---|---|---|
| Input Tab: | ||
| 1 | Form Name | Form Name (Module name) for which record is to be updated. Supported Modules: - Supported primary modules for the cloud: Incident/Request, Problem, Change, Project, Solution, Release, and custom modules. - Supported primary modules for on premise: Incident/Request, Change, Project, Solution, User. Unsupported Modules: - There are few unsupported modules for on-premise as well as cloud deployment such as Contracts, Purchases, Assets. - The modules other than the supported ones listed above (in the Supported Modules) also comes under the unsupported modules. - The problem module is not supported in the on-premise deployment. - Secondary modules or sub-forms are not supported in this plugin step. |
| 2 | Accept Fields as JSON | Enable checkbox to accept field names as JSON input. In the JSON text you can have dynamic fields to insert rather than static fields to be provided in the Table Fields. Leave this unchecked to provide Table Fields as input. |
| 3 | JSON | The referenced field should have JSON text in a valid format to update a record. About JSON text: If ‘Accept Fields as JSON’ checkbox is enabled this field is activated. Choose a field containing the JSON text. JSON text should contain key-value pairs enclosed by double quotes (“) enclosure. Provide all the required or mandatory fields as well as other fields to be inserted as keys in the JSON. Note: The JSON could be from any input step such as Generate rows, Text File input, Excel Input etc. JSON text can only be accepted from input fields from previous steps and not as files directly. JSON text can also be specified by a parameter already defined. The data type is string. This field is optional. Sample JSON key value pairs: [ { "displayName": "Service","value": "HR Service Desk" }, { "displayName": "Title", "value": "Test_KA10" } ] Note: - The supported format to provide DateTime values is “MMM dd yyyy hh:mm a” (E.g. Apr 19 2021 10:00 am). - JSON format for checkbox should be as “fieldName”: “[Option-1, Option-2]”. - For Multi-select fields provide comma separated values. - The group type fields are not supported in this plugin step. - The supported fo |
| 4 | ID | ID of the record to be updated (You can get this ID from URL when you go to that particular request from ManageEngine SDP UI). |
| 5 | Button: Get | Click to get the list of Request ID’s. Note: - The button will only work when static values or environment variables are provided for Connection details. Get button will not work if the previous step fields are provided for Connection details. - On clicking get button, maximum 1000 record IDs will get populated. |
| Table Fields: | ||
| 6 | Variable Field Name | This field accepts values from previous fields in the stream/environment variables or variables (e.g. run-time parameters for Request fields) The data type is string. This field is optional. |
| 7 | Static Field Name | On click of this cell, fields associated with the form name/module name are populated. The data type is string. This field is optional. Note: One of either Variable Field Name or Static Field Name must be provided. If both are provided then Static Field Name is taken. |
| 8 | Field Value | Valid values for the field associated with the field name. The data type is string. This field is mandatory. Note: - The supported format to provide DateTime values is “MMM dd yyyy hh:mm a” (E.g. Apr 19 2021 10:00 am). - Field format for checkbox should be - [Option-1, Option-2]. - For Multi-select fields provide comma separated values. - The group type fields are not supported in this plugin step. - In the User module of ManageEngine on-premise, to set the “Purchase Approval Limit” as “Unlimited”, the expected value to be provided is -1. - In ManageEngine on-premise, field “Requester allowed to view” accepts the value as the order of that element in the dropdown and not as the exact string of that element. |